Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Privacy settings manual scenarios #26764

Merged
merged 16 commits into from
Sep 11, 2024
Merged

docs: Privacy settings manual scenarios #26764

merged 16 commits into from
Sep 11, 2024

Conversation

benjisclowder
Copy link
Contributor

@benjisclowder benjisclowder commented Aug 29, 2024 •
edited
Loading

Description

This PR documents the manual test scenarios for several privacy settings functionalities. Below is a summary of the validations included in these manual scenarios:

  1. Privacy settings: Check “network details check” toggle works correctly
  • Validate that the 'Network details check' toggle is present in the Security & Privacy settings and is ON by default.
  • Validate that the toggle can be turned on and off.
  • Validate that when the toggle is turned on, MetaMask checks the network details against the information provided by chainid.network when attempting to connect to a blockchain network.
  1. Privacy settings: Check “IPFS gateway” toggle works correctly
  • Validate that the 'IPFS gateway' toggle is present in the Security & Privacy settings and is ON by default.
  • Validate that the toggle can be turned on and off.
  • Validate that when the toggle is turned on, MetaMask shows images of NFTs.
  • Validate that when the toggle is turned off, NFT images are replaced by placeholders and I am prompted to turn on IPFS resolution.
  1. Privacy settings: Check “Show ENS domains in address bar” toggle works correctly
  • Validate that the 'Show ENS domains in address bar' toggle is present in the Security & Privacy settings and is ON by default.
  • Validate that the toggle can be turned on and off.
  • Validate that when the toggle is turned on, ENS domain name is displayed alongside the public address.
  1. Privacy settings: Check “Display NFT Media” toggle works correctly
  • Validate that the 'Display NFT media' toggle is present in the Security & Privacy settings and is ON by default.
  • Validate that the toggle can be turned on and off.
  • Validate that when the toggle is turned on, MetaMask displays NFT media and data.
  • Validate that NFT autodetection relies on this setting and won't be available when this is turned off.

Open in GitHub Codespaces

Related issues

Fixes: #21963, #21964, #21966, #21967

Manual testing steps

Please click link for the rendered view

--> test/manual-scenarios/privacy-settings/check "Network details check" toggle works correctly.md
https://github.com/user-attachments/assets/9a60b564-7503-44b9-9ca0-810e857a4529

--> test/manual-scenarios/privacy-settings/check "IPFS gateway" toggle works correctly.md
https://github.com/user-attachments/assets/3e2e5135-9343-4d8c-808f-e3f599928d52

--> test/manual-scenarios/privacy-settings/check "Show ENS domains in address bar" toggle works correctly.md
https://github.com/user-attachments/assets/79df9cc4-0083-458f-be06-d524c7ca135f

--> test/manual-scenarios/privacy-settings/check "Display NFT media" toggle works correctly.md
https://github.com/user-attachments/assets/a54ef74f-00b4-4554-a7ac-9cd1e53800a4

@benjisclowder benjisclowder self-assigned this Aug 29, 2024
@benjisclowder benjisclowder requested a review from a team as a code owner August 29, 2024 16:42
@github-actions GitHub Actions
Copy link
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@metamaskbot metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Aug 29, 2024
@codecov Codecov
Copy link

codecov bot commented Aug 29, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.15%. Comparing base (3797b2f) to head (299e85b).
Report is 2 commits behind head on develop.

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop   #26764   +/-   ##
========================================
  Coverage    70.15%   70.15%           
========================================
  Files         1425     1425           
  Lines        49656    49656           
  Branches     13892    13892           
========================================
  Hits         34833    34833           
  Misses       14823    14823

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@metamaskbot
Copy link
Collaborator

Builds ready [9e8f59c]
Page Load Metrics (1822 ± 87 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint16472429181917785
domContentLoaded16372408179517283
load16482432182218187
domInteractive13105342110
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

@metamaskbot
Copy link
Collaborator

Builds ready [699807a]
Page Load Metrics (1648 ± 70 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint21621091443526253
domContentLoaded14612073162614469
load14662113164814670
domInteractive207832147
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

@metamaskbot
Copy link
Collaborator

Builds ready [d1c2f1a]
Page Load Metrics (1753 ± 61 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint19720361515559268
domContentLoaded15622025173612459
load15712045175312861
domInteractive127134147
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

hjetpoluru
hjetpoluru previously approved these changes Sep 4, 2024
View reviewed changes
Copy link
Contributor

@hjetpoluru hjetpoluru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@metamaskbot
Copy link
Collaborator

Builds ready [754ecb5]
Page Load Metrics (1709 ± 96 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint20023091274676325
domContentLoaded14372169168917986
load14392335170920196
domInteractive23119422813
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

chloeYue
chloeYue reviewed Sep 5, 2024
View reviewed changes
Copy link
Contributor

@chloeYue chloeYue left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @benjisclowder , the scenarios looks good for me. Could you remove this change in the PR?
Screenshot 2024-09-05 at 14 34 28

@hjetpoluru
Copy link
Contributor

@chloeYue, good observation!! @benjisclowder, I removed the folder.

@hjetpoluru hjetpoluru self-requested a review September 6, 2024 14:40
hjetpoluru
hjetpoluru previously approved these changes Sep 6, 2024
View reviewed changes
@benjisclowder
Copy link
Contributor Author

@chloeYue, good observation!! @benjisclowder, I removed the folder.

Thanks for that, Harika. Fortunately I've managed to solve my issue with pushing changes on remote and this PR is looking good now. I would appreciate one last review to be able to merge. Thank you!

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@metamaskbot
Copy link
Collaborator

Builds ready [299e85b]
Page Load Metrics (1742 ± 68 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint24019131592422202
domContentLoaded15032117172314067
load15082120174214268
domInteractive14197463919

@benjisclowder benjisclowder merged commit 5297b2c into develop Sep 11, 2024
78 checks passed
@benjisclowder benjisclowder deleted the privacy-settings-manual-scenarios branch September 11, 2024 13:27
@github-actions github-actions bot locked and limited conversation to collaborators Sep 11, 2024
@metamaskbot metamaskbot added the release-12.6.0 Issue or pull request that will be included in release 12.6.0 label Sep 11, 2024
hjetpoluru pushed a commit that referenced this pull request Sep 11, 2024
@HowardBraham
fix(windows): cannot use double-quotes in filenames on Windows (#27071)
4c73dc6 
## **Description**

#26764 created files with double-quotes in filenames. Windows cannot
handle that, and gives this error

```
Check Out Branch:
invalid path 'test/manual-scenarios/privacy-settings/check "Display NFT media" toggle works correctly.md'
invalid path 'test/manual-scenarios/privacy-settings/check "IPFS gateway" toggle works correctly.md'
invalid path 'test/manual-scenarios/privacy-settings/check "Network details check" toggle works correctly.md'
invalid path 'test/manual-scenarios/privacy-settings/check "Show ENS domains in address bar" toggle works correctly.md'
```

Renamed to use single quotes.

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/27071?quickstart=1)

## **Related issues**

Fixes: #26764

## **Manual testing steps**
## **Screenshots/Recordings**
### **Before**
### **After**
## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
@metamaskbot metamaskbot added release-12.5.0 Issue or pull request that will be included in release 12.5.0 and removed release-12.6.0 Issue or pull request that will be included in release 12.6.0 labels Sep 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@hjetpoluru hjetpoluru hjetpoluru approved these changes

@chloeYue chloeYue chloeYue approved these changes

@seaona seaona Awaiting requested review from seaona

Assignees

@benjisclowder benjisclowder

Labels
INVALID-PR-TEMPLATE PR's body doesn't match template release-12.5.0 Issue or pull request that will be included in release 12.5.0 team-extension-platform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Privacy settings: Check “network details check” toggle works correctly
5 participants
@benjisclowder @metamaskbot @hjetpoluru @seaona @chloeYue